<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (c) 2004-2011 QOS.ch<a name="line.2"></a>
<span class="sourceLineNo">003</span> * All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * Permission is hereby granted, free  of charge, to any person obtaining<a name="line.5"></a>
<span class="sourceLineNo">006</span> * a  copy  of this  software  and  associated  documentation files  (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "Software"), to  deal in  the Software without  restriction, including<a name="line.7"></a>
<span class="sourceLineNo">008</span> * without limitation  the rights to  use, copy, modify,  merge, publish,<a name="line.8"></a>
<span class="sourceLineNo">009</span> * distribute,  sublicense, and/or sell  copies of  the Software,  and to<a name="line.9"></a>
<span class="sourceLineNo">010</span> * permit persons to whom the Software  is furnished to do so, subject to<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the following conditions:<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * The  above  copyright  notice  and  this permission  notice  shall  be<a name="line.13"></a>
<span class="sourceLineNo">014</span> * included in all copies or substantial portions of the Software.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,<a name="line.16"></a>
<span class="sourceLineNo">017</span> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF<a name="line.17"></a>
<span class="sourceLineNo">018</span> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND<a name="line.18"></a>
<span class="sourceLineNo">019</span> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<a name="line.19"></a>
<span class="sourceLineNo">020</span> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<a name="line.20"></a>
<span class="sourceLineNo">021</span> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION<a name="line.21"></a>
<span class="sourceLineNo">022</span> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>package org.slf4j;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.io.Closeable;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.helpers.NOPMDCAdapter;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.helpers.BasicMDCAdapter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.helpers.Util;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.slf4j.impl.StaticMDCBinder;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.slf4j.spi.MDCAdapter;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * This class hides and serves as a substitute for the underlying logging<a name="line.37"></a>
<span class="sourceLineNo">038</span> * system's MDC implementation.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * <a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * If the underlying logging system offers MDC functionality, then SLF4J's MDC,<a name="line.41"></a>
<span class="sourceLineNo">042</span> * i.e. this class, will delegate to the underlying system's MDC. Note that at<a name="line.42"></a>
<span class="sourceLineNo">043</span> * this time, only two logging systems, namely log4j and logback, offer MDC<a name="line.43"></a>
<span class="sourceLineNo">044</span> * functionality. For java.util.logging which does not support MDC,<a name="line.44"></a>
<span class="sourceLineNo">045</span> * {@link BasicMDCAdapter} will be used. For other systems, i.e. slf4j-simple<a name="line.45"></a>
<span class="sourceLineNo">046</span> * and slf4j-nop, {@link NOPMDCAdapter} will be used.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Thus, as a SLF4J user, you can take advantage of MDC in the presence of log4j,<a name="line.49"></a>
<span class="sourceLineNo">050</span> * logback, or java.util.logging, but without forcing these systems as<a name="line.50"></a>
<span class="sourceLineNo">051</span> * dependencies upon your users.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * <a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * For more information on MDC please see the &lt;a<a name="line.54"></a>
<span class="sourceLineNo">055</span> * href="http://logback.qos.ch/manual/mdc.html"&gt;chapter on MDC&lt;/a&gt; in the<a name="line.55"></a>
<span class="sourceLineNo">056</span> * logback manual.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * <a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Please note that all methods in this class are static.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * <a name="line.60"></a>
<span class="sourceLineNo">061</span> * @author Ceki G&amp;uuml;lc&amp;uuml;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @since 1.4.1<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span>public class MDC {<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    static final String NULL_MDCA_URL = "http://www.slf4j.org/codes.html#null_MDCA";<a name="line.66"></a>
<span class="sourceLineNo">067</span>    static final String NO_STATIC_MDC_BINDER_URL = "http://www.slf4j.org/codes.html#no_static_mdc_binder";<a name="line.67"></a>
<span class="sourceLineNo">068</span>    static MDCAdapter mdcAdapter;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * An adapter to remove the key when done.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     */<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public static class MDCCloseable implements Closeable {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        private final String key;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>        private MDCCloseable(String key) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>            this.key = key;<a name="line.77"></a>
<span class="sourceLineNo">078</span>        }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>        public void close() {<a name="line.80"></a>
<span class="sourceLineNo">081</span>            MDC.remove(this.key);<a name="line.81"></a>
<span class="sourceLineNo">082</span>        }<a name="line.82"></a>
<span class="sourceLineNo">083</span>    }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    private MDC() {<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * As of SLF4J version 1.7.14, StaticMDCBinder classes shipping in various bindings<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * come with a getSingleton() method. Previously only a public field called SINGLETON <a name="line.90"></a>
<span class="sourceLineNo">091</span>     * was available.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * <a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @return MDCAdapter<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @throws NoClassDefFoundError in case no binding is available<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @since 1.7.14<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span>    private static MDCAdapter bwCompatibleGetMDCAdapterFromBinder() throws NoClassDefFoundError {<a name="line.97"></a>
<span class="sourceLineNo">098</span>        try {<a name="line.98"></a>
<span class="sourceLineNo">099</span>            return StaticMDCBinder.getSingleton().getMDCA();<a name="line.99"></a>
<span class="sourceLineNo">100</span>        } catch (NoSuchMethodError nsme) {<a name="line.100"></a>
<span class="sourceLineNo">101</span>            // binding is probably a version of SLF4J older than 1.7.14<a name="line.101"></a>
<span class="sourceLineNo">102</span>            return StaticMDCBinder.SINGLETON.getMDCA();<a name="line.102"></a>
<span class="sourceLineNo">103</span>        }<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    static {<a name="line.106"></a>
<span class="sourceLineNo">107</span>        try {<a name="line.107"></a>
<span class="sourceLineNo">108</span>            mdcAdapter = bwCompatibleGetMDCAdapterFromBinder();<a name="line.108"></a>
<span class="sourceLineNo">109</span>        } catch (NoClassDefFoundError ncde) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>            mdcAdapter = new NOPMDCAdapter();<a name="line.110"></a>
<span class="sourceLineNo">111</span>            String msg = ncde.getMessage();<a name="line.111"></a>
<span class="sourceLineNo">112</span>            if (msg != null &amp;&amp; msg.contains("StaticMDCBinder")) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>                Util.report("Failed to load class \"org.slf4j.impl.StaticMDCBinder\".");<a name="line.113"></a>
<span class="sourceLineNo">114</span>                Util.report("Defaulting to no-operation MDCAdapter implementation.");<a name="line.114"></a>
<span class="sourceLineNo">115</span>                Util.report("See " + NO_STATIC_MDC_BINDER_URL + " for further details.");<a name="line.115"></a>
<span class="sourceLineNo">116</span>            } else {<a name="line.116"></a>
<span class="sourceLineNo">117</span>                throw ncde;<a name="line.117"></a>
<span class="sourceLineNo">118</span>            }<a name="line.118"></a>
<span class="sourceLineNo">119</span>        } catch (Exception e) {<a name="line.119"></a>
<span class="sourceLineNo">120</span>            // we should never get here<a name="line.120"></a>
<span class="sourceLineNo">121</span>            Util.report("MDC binding unsuccessful.", e);<a name="line.121"></a>
<span class="sourceLineNo">122</span>        }<a name="line.122"></a>
<span class="sourceLineNo">123</span>    }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>    /**<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * Put a diagnostic context value (the &lt;code&gt;val&lt;/code&gt; parameter) as identified with the<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * &lt;code&gt;key&lt;/code&gt; parameter into the current thread's diagnostic context map. The<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * &lt;code&gt;key&lt;/code&gt; parameter cannot be null. The &lt;code&gt;val&lt;/code&gt; parameter<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * can be null only if the underlying implementation supports it.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * <a name="line.130"></a>
<span class="sourceLineNo">131</span>     * &lt;p&gt;<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * This method delegates all work to the MDC of the underlying logging system.<a name="line.132"></a>
<span class="sourceLineNo">133</span>     *<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * @param key non-null key <a name="line.134"></a>
<span class="sourceLineNo">135</span>     * @param val value to put in the map<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * <a name="line.136"></a>
<span class="sourceLineNo">137</span>     * @throws IllegalArgumentException<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *           in case the "key" parameter is null<a name="line.138"></a>
<span class="sourceLineNo">139</span>     */<a name="line.139"></a>
<span class="sourceLineNo">140</span>    public static void put(String key, String val) throws IllegalArgumentException {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        if (key == null) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>            throw new IllegalArgumentException("key parameter cannot be null");<a name="line.142"></a>
<span class="sourceLineNo">143</span>        }<a name="line.143"></a>
<span class="sourceLineNo">144</span>        if (mdcAdapter == null) {<a name="line.144"></a>
<span class="sourceLineNo">145</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.145"></a>
<span class="sourceLineNo">146</span>        }<a name="line.146"></a>
<span class="sourceLineNo">147</span>        mdcAdapter.put(key, val);<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>    /**<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * Put a diagnostic context value (the &lt;code&gt;val&lt;/code&gt; parameter) as identified with the<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * &lt;code&gt;key&lt;/code&gt; parameter into the current thread's diagnostic context map. The<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * &lt;code&gt;key&lt;/code&gt; parameter cannot be null. The &lt;code&gt;val&lt;/code&gt; parameter<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * can be null only if the underlying implementation supports it.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * &lt;p&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * This method delegates all work to the MDC of the underlying logging system.<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * &lt;p&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * This method return a &lt;code&gt;Closeable&lt;/code&gt; object who can remove &lt;code&gt;key&lt;/code&gt; when<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * &lt;code&gt;close&lt;/code&gt; is called.<a name="line.160"></a>
<span class="sourceLineNo">161</span>     *<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * &lt;p&gt;<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * Useful with Java 7 for example :<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * &lt;code&gt;<a name="line.164"></a>
<span class="sourceLineNo">165</span>     *   try(MDC.MDCCloseable closeable = MDC.putCloseable(key, value)) {<a name="line.165"></a>
<span class="sourceLineNo">166</span>     *     ....<a name="line.166"></a>
<span class="sourceLineNo">167</span>     *   }<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * &lt;/code&gt;<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @param key non-null key<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @param val value to put in the map<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * @return a &lt;code&gt;Closeable&lt;/code&gt; who can remove &lt;code&gt;key&lt;/code&gt; when &lt;code&gt;close&lt;/code&gt;<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * is called.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     *<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * @throws IllegalArgumentException<a name="line.175"></a>
<span class="sourceLineNo">176</span>     *           in case the "key" parameter is null<a name="line.176"></a>
<span class="sourceLineNo">177</span>     */<a name="line.177"></a>
<span class="sourceLineNo">178</span>    public static MDCCloseable putCloseable(String key, String val) throws IllegalArgumentException {<a name="line.178"></a>
<span class="sourceLineNo">179</span>        put(key, val);<a name="line.179"></a>
<span class="sourceLineNo">180</span>        return new MDCCloseable(key);<a name="line.180"></a>
<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span>    /**<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * Get the diagnostic context identified by the &lt;code&gt;key&lt;/code&gt; parameter. The<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * &lt;code&gt;key&lt;/code&gt; parameter cannot be null.<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * <a name="line.186"></a>
<span class="sourceLineNo">187</span>     * &lt;p&gt;<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * This method delegates all work to the MDC of the underlying logging system.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @param key  <a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @return the string value identified by the &lt;code&gt;key&lt;/code&gt; parameter.<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * @throws IllegalArgumentException<a name="line.192"></a>
<span class="sourceLineNo">193</span>     *           in case the "key" parameter is null<a name="line.193"></a>
<span class="sourceLineNo">194</span>     */<a name="line.194"></a>
<span class="sourceLineNo">195</span>    public static String get(String key) throws IllegalArgumentException {<a name="line.195"></a>
<span class="sourceLineNo">196</span>        if (key == null) {<a name="line.196"></a>
<span class="sourceLineNo">197</span>            throw new IllegalArgumentException("key parameter cannot be null");<a name="line.197"></a>
<span class="sourceLineNo">198</span>        }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span>        if (mdcAdapter == null) {<a name="line.200"></a>
<span class="sourceLineNo">201</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.201"></a>
<span class="sourceLineNo">202</span>        }<a name="line.202"></a>
<span class="sourceLineNo">203</span>        return mdcAdapter.get(key);<a name="line.203"></a>
<span class="sourceLineNo">204</span>    }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>    /**<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * Remove the diagnostic context identified by the &lt;code&gt;key&lt;/code&gt; parameter using<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * the underlying system's MDC implementation. The &lt;code&gt;key&lt;/code&gt; parameter<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * cannot be null. This method does nothing if there is no previous value<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * associated with &lt;code&gt;key&lt;/code&gt;.<a name="line.210"></a>
<span class="sourceLineNo">211</span>     *<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * @param key  <a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @throws IllegalArgumentException<a name="line.213"></a>
<span class="sourceLineNo">214</span>     *           in case the "key" parameter is null<a name="line.214"></a>
<span class="sourceLineNo">215</span>     */<a name="line.215"></a>
<span class="sourceLineNo">216</span>    public static void remove(String key) throws IllegalArgumentException {<a name="line.216"></a>
<span class="sourceLineNo">217</span>        if (key == null) {<a name="line.217"></a>
<span class="sourceLineNo">218</span>            throw new IllegalArgumentException("key parameter cannot be null");<a name="line.218"></a>
<span class="sourceLineNo">219</span>        }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span>        if (mdcAdapter == null) {<a name="line.221"></a>
<span class="sourceLineNo">222</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.222"></a>
<span class="sourceLineNo">223</span>        }<a name="line.223"></a>
<span class="sourceLineNo">224</span>        mdcAdapter.remove(key);<a name="line.224"></a>
<span class="sourceLineNo">225</span>    }<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span>    /**<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * Clear all entries in the MDC of the underlying implementation.<a name="line.228"></a>
<span class="sourceLineNo">229</span>     */<a name="line.229"></a>
<span class="sourceLineNo">230</span>    public static void clear() {<a name="line.230"></a>
<span class="sourceLineNo">231</span>        if (mdcAdapter == null) {<a name="line.231"></a>
<span class="sourceLineNo">232</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.232"></a>
<span class="sourceLineNo">233</span>        }<a name="line.233"></a>
<span class="sourceLineNo">234</span>        mdcAdapter.clear();<a name="line.234"></a>
<span class="sourceLineNo">235</span>    }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span>    /**<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * Return a copy of the current thread's context map, with keys and values of<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * type String. Returned value may be null.<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * <a name="line.240"></a>
<span class="sourceLineNo">241</span>     * @return A copy of the current thread's context map. May be null.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * @since 1.5.1<a name="line.242"></a>
<span class="sourceLineNo">243</span>     */<a name="line.243"></a>
<span class="sourceLineNo">244</span>    public static Map&lt;String, String&gt; getCopyOfContextMap() {<a name="line.244"></a>
<span class="sourceLineNo">245</span>        if (mdcAdapter == null) {<a name="line.245"></a>
<span class="sourceLineNo">246</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.246"></a>
<span class="sourceLineNo">247</span>        }<a name="line.247"></a>
<span class="sourceLineNo">248</span>        return mdcAdapter.getCopyOfContextMap();<a name="line.248"></a>
<span class="sourceLineNo">249</span>    }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span>    /**<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * Set the current thread's context map by first clearing any existing map and<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * then copying the map passed as parameter. The context map passed as<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * parameter must only contain keys and values of type String.<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * <a name="line.255"></a>
<span class="sourceLineNo">256</span>     * @param contextMap<a name="line.256"></a>
<span class="sourceLineNo">257</span>     *          must contain only keys and values of type String<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * @since 1.5.1<a name="line.258"></a>
<span class="sourceLineNo">259</span>     */<a name="line.259"></a>
<span class="sourceLineNo">260</span>    public static void setContextMap(Map&lt;String, String&gt; contextMap) {<a name="line.260"></a>
<span class="sourceLineNo">261</span>        if (mdcAdapter == null) {<a name="line.261"></a>
<span class="sourceLineNo">262</span>            throw new IllegalStateException("MDCAdapter cannot be null. See also " + NULL_MDCA_URL);<a name="line.262"></a>
<span class="sourceLineNo">263</span>        }<a name="line.263"></a>
<span class="sourceLineNo">264</span>        mdcAdapter.setContextMap(contextMap);<a name="line.264"></a>
<span class="sourceLineNo">265</span>    }<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span>    /**<a name="line.267"></a>
<span class="sourceLineNo">268</span>     * Returns the MDCAdapter instance currently in use.<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * <a name="line.269"></a>
<span class="sourceLineNo">270</span>     * @return the MDcAdapter instance currently in use.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * @since 1.4.2<a name="line.271"></a>
<span class="sourceLineNo">272</span>     */<a name="line.272"></a>
<span class="sourceLineNo">273</span>    public static MDCAdapter getMDCAdapter() {<a name="line.273"></a>
<span class="sourceLineNo">274</span>        return mdcAdapter;<a name="line.274"></a>
<span class="sourceLineNo">275</span>    }<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span>}<a name="line.277"></a>




























































</pre>
</div>
</body>
</html>
